From 9f174bdadffeee040d83f322029b853b317f7805 Mon Sep 17 00:00:00 2001 From: robertl Date: Thu, 8 Jun 2006 02:50:40 +0000 Subject: [PATCH] Try to document the horror of the command line options we provide for Tiger. git-svn-id: http://gpsbabel.googlecode.com/svn/trunk@2139 f51c46e8-681c-474f-0cfe-069cfd0219fb --- .../xmldoc/formats/options/tiger-genurl.xml | 17 +++++++++++++++++ .../formats/options/tiger-iconismarker.xml | 5 ++++- .../xmldoc/formats/options/tiger-margin.xml | 8 +++++++- .../xmldoc/formats/options/tiger-newmarker.xml | 4 +++- .../xmldoc/formats/options/tiger-nolabels.xml | 4 +++- .../xmldoc/formats/options/tiger-oldmarker.xml | 4 +++- .../xmldoc/formats/options/tiger-oldthresh.xml | 6 +++++- gpsbabel/xmldoc/formats/options/tiger-snlen.xml | 6 +++++- .../formats/options/tiger-suppresswhite.xml | 5 ++++- .../xmldoc/formats/options/tiger-xpixels.xml | 4 +++- .../xmldoc/formats/options/tiger-ypixels.xml | 3 +++ 11 files changed, 57 insertions(+), 9 deletions(-) diff --git a/gpsbabel/xmldoc/formats/options/tiger-genurl.xml b/gpsbabel/xmldoc/formats/options/tiger-genurl.xml index 8b1378917..d1bd24f2b 100644 --- a/gpsbabel/xmldoc/formats/options/tiger-genurl.xml +++ b/gpsbabel/xmldoc/formats/options/tiger-genurl.xml @@ -1 +1,18 @@ + +genurl is a convenience option for generating the scaling paramaters +when accessing the Tiger servers. It will output the latitude, longitude, +height, and width parameters in a form suitable for use in the URL to generate +a map that will hold all the points to be displayed and is suitably scaled +and centered. + +For example: +gpsbabel -i geo -f geocaching.loc -o tiger,genurl=tiger.ctr -F tiger.dat +may create tiger.ctr with +lat=36.042108&lon=-86.877408&ht=0.161172&wid=0.591771&iwd=768&iht=768 + +After uploading tiger.dat to a public server, a request to + http://tiger.census.gov/cgi-bin/mapgen?murl=$THATFILE$(cat tiger.ctr) +will return a gif file from the tiger server that's suitably scaled. + + diff --git a/gpsbabel/xmldoc/formats/options/tiger-iconismarker.xml b/gpsbabel/xmldoc/formats/options/tiger-iconismarker.xml index 8b1378917..899aed557 100644 --- a/gpsbabel/xmldoc/formats/options/tiger-iconismarker.xml +++ b/gpsbabel/xmldoc/formats/options/tiger-iconismarker.xml @@ -1 +1,4 @@ - + This options signifies that the icon in the incoming format is to be used +without change in the generated Tiger output file. Without this option, +GPSBabel tries to color pins based on their creation time and certain +Geocaching traits when available. diff --git a/gpsbabel/xmldoc/formats/options/tiger-margin.xml b/gpsbabel/xmldoc/formats/options/tiger-margin.xml index 8b1378917..e9b58184a 100644 --- a/gpsbabel/xmldoc/formats/options/tiger-margin.xml +++ b/gpsbabel/xmldoc/formats/options/tiger-margin.xml @@ -1 +1,7 @@ - +This option specifies a margin around the maps for the genurl options. +The margin may be specified in either decimal degrees or as a +percentage. + +This option is most useful for ensuring there is adaequate space for +the label around the markers when generating automatically scaled maps. + diff --git a/gpsbabel/xmldoc/formats/options/tiger-newmarker.xml b/gpsbabel/xmldoc/formats/options/tiger-newmarker.xml index 8b1378917..ec3af7c12 100644 --- a/gpsbabel/xmldoc/formats/options/tiger-newmarker.xml +++ b/gpsbabel/xmldoc/formats/options/tiger-newmarker.xml @@ -1 +1,3 @@ - +This option specifies the pin to be used if a waypoint has a creation +time older than 'oldthresh' days. +The default is "greenpin". diff --git a/gpsbabel/xmldoc/formats/options/tiger-nolabels.xml b/gpsbabel/xmldoc/formats/options/tiger-nolabels.xml index 8b1378917..33ec2c1cb 100644 --- a/gpsbabel/xmldoc/formats/options/tiger-nolabels.xml +++ b/gpsbabel/xmldoc/formats/options/tiger-nolabels.xml @@ -1 +1,3 @@ - +This option tells GPSBabel to not generate labels on the pins. If +this is true, the description of the incoming waypoints are ignored and not +placed on the pins. diff --git a/gpsbabel/xmldoc/formats/options/tiger-oldmarker.xml b/gpsbabel/xmldoc/formats/options/tiger-oldmarker.xml index 8b1378917..abce81d92 100644 --- a/gpsbabel/xmldoc/formats/options/tiger-oldmarker.xml +++ b/gpsbabel/xmldoc/formats/options/tiger-oldmarker.xml @@ -1 +1,3 @@ - +This option specifies the pin to be used if a waypoint has a creation +time newer than 'oldthresh' days. +The default is "redpin". diff --git a/gpsbabel/xmldoc/formats/options/tiger-oldthresh.xml b/gpsbabel/xmldoc/formats/options/tiger-oldthresh.xml index 8b1378917..919026372 100644 --- a/gpsbabel/xmldoc/formats/options/tiger-oldthresh.xml +++ b/gpsbabel/xmldoc/formats/options/tiger-oldthresh.xml @@ -1 +1,5 @@ - +This options allows you to control the threshold in days between +whether a pin is considered "new" (and thus potentially governed by the +'newmarker' option) or "old" (and thus potentially governed by the +'oldmarker' option). + diff --git a/gpsbabel/xmldoc/formats/options/tiger-snlen.xml b/gpsbabel/xmldoc/formats/options/tiger-snlen.xml index 8b1378917..ae39cd736 100644 --- a/gpsbabel/xmldoc/formats/options/tiger-snlen.xml +++ b/gpsbabel/xmldoc/formats/options/tiger-snlen.xml @@ -1 +1,5 @@ - + +The snlen option controls the maximum length of names generated by the '-s' +option. It's particularly useful in Tiger maps to avoid the amount of clutter +generated by potentially lengthy labels on the markers. + diff --git a/gpsbabel/xmldoc/formats/options/tiger-suppresswhite.xml b/gpsbabel/xmldoc/formats/options/tiger-suppresswhite.xml index 8b1378917..6576ef45c 100644 --- a/gpsbabel/xmldoc/formats/options/tiger-suppresswhite.xml +++ b/gpsbabel/xmldoc/formats/options/tiger-suppresswhite.xml @@ -1 +1,4 @@ - + +When set, this options tells the '-s' smartname generator to not allow +any spaces in the labels generated for markers. + diff --git a/gpsbabel/xmldoc/formats/options/tiger-xpixels.xml b/gpsbabel/xmldoc/formats/options/tiger-xpixels.xml index 8b1378917..a857af3ed 100644 --- a/gpsbabel/xmldoc/formats/options/tiger-xpixels.xml +++ b/gpsbabel/xmldoc/formats/options/tiger-xpixels.xml @@ -1 +1,3 @@ - +The xpixels argument lets you specify the number of pixels to be +generated by the Tiger server along the horizontal axis when using the +'genurl' option. diff --git a/gpsbabel/xmldoc/formats/options/tiger-ypixels.xml b/gpsbabel/xmldoc/formats/options/tiger-ypixels.xml index 8b1378917..846de24a4 100644 --- a/gpsbabel/xmldoc/formats/options/tiger-ypixels.xml +++ b/gpsbabel/xmldoc/formats/options/tiger-ypixels.xml @@ -1 +1,4 @@ +The ypixels argument lets you specify the number of pixels to be +generated by the Tiger server along the vertical axis when using the +'genurl' option. -- 2.30.2